Skip to content

Use a neutral example standard in docs and comments - #6

Merged
daniel-rossier merged 1 commit into
mainfrom
example-standard-genericize
Nov 13, 2026
Merged

daniel-rossier merged 1 commit into
mainfrom
example-standard-genericize

Conversation

@daniel-rossier

Copy link
Copy Markdown
Contributor

Replace the VITA 49.2 worked example with a generic EXAMPLE-STD-1.0 placeholder across documentation, comments and docstrings (12 files, 47 replacements), so the public repository does not name the specific commercial standard in its illustrative examples.

Kept on purpose

  • The functional ANSI-VITA-49.2 role taxonomy in standard_profiles.py and the VITA entry in the standards-body list in normative_claims.py — removing these drops real capability.
  • The test suite (client/tests/), which still binds the example standard by its real id.

So the docs and comments no longer name the standard; the taxonomy, the body list and the tests still do. Taking it out of the tests as well is a larger, separate change.

Verified: py_compile on all touched modules; the doc examples read coherently. The full test suite should be run on the configured host.

Replace the VITA 49.2 worked example with a generic EXAMPLE-STD-1.0 placeholder
across the documentation, comments and docstrings, so the public repository does
not name the specific commercial standard in its illustrative examples.

The functional pieces that genuinely name it are left untouched -- the
ANSI-VITA-49.2 role taxonomy in standard_profiles.py and the VITA entry in the
standards-body list in normative_claims.py -- and so is the test suite, which
still binds the example standard by its real id.
@daniel-rossier
daniel-rossier merged commit 22f1936 into main Nov 13, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant